RaTweening.Core.RaTweeningProcessor Class Reference

The Processor can be used to manually handle the states of tweens which have been registered to it. It completely handles all the state related logics such as handling their delays, lifetime, evaluations and all other state related aspects. This system is used by RaTweeningEngine and RaTweenSequence to handle their internal tweens.

‍Note: By Default, a tween runs in RealTime. To change it to GameTime, call RaTweenUtilExtensions.SetToGameTime<TweenT>(TweenT) on that tween.

More...

Inheritance diagram for RaTweening.Core.RaTweeningProcessor:

Public Member Functions
void	Stop (bool cleanEndedTweens=true)
	Ends all tweens within the processor ‍Note: See RaTweenBase.Stop() More...
void	Rewind (bool inclDelay=true)
	Rewinds all tweens within the processor. ‍Note: See RaTweenBase.Rewind(bool) More...
void	Reset (bool resumeAfterReset=false)
	Resets all tweens within the processor. ‍Note: See RaTweenBase.Reset(bool) More...
void	Complete (bool cleanEndedTweens=true)
	Completes all tweens within the processor ‍Note: See RaTweenBase.Complete()
void	Step (float deltaTime, bool cleanEndedTweens=true)
	This method progresses the tweens registered through their various states. Handling their delays, lifetime, evaluations and all other state related aspects. More...
void	CleanEndedTweens ()
	Kills all Tweens which RaTweenBase.HasEnded
void	Dispose ()
TweenT	RegisterTween< TweenT > (TweenT tween)
	This method attempts to register the given tween in the system, setting the tween state to RaTweenBase.State.ToStart After Registration, the tween will go through the processing flow by calling the Step method. ‍Note: Registration is only allowed if the state of the tween is RaTweenBase.State.None, else it will ignore it. More...
TweenT	UnregisterTween< TweenT > (TweenT tween)
	This method attempts to unregister the given tween from the system. After Unregistration, the tween will no longer go through the processing flow by calling the Step method. ‍Note: Unregistration is only allowed if the state of the tween is NOT RaTweenBase.State.None, else it will ignore it. More...

Properties
int	TweensCount [get]

Detailed Description

The Processor can be used to manually handle the states of tweens which have been registered to it. It completely handles all the state related logics such as handling their delays, lifetime, evaluations and all other state related aspects. This system is used by RaTweeningEngine and RaTweenSequence to handle their internal tweens.

‍Note: By Default, a tween runs in RealTime. To change it to GameTime, call RaTweenUtilExtensions.SetToGameTime<TweenT>(TweenT) on that tween.

Member Function Documentation

RegisterTween< TweenT >()

TweenT RaTweening.Core.RaTweeningProcessor.RegisterTween< TweenT >

(

TweenT

tween

)

This method attempts to register the given tween in the system, setting the tween state to RaTweenBase.State.ToStart After Registration, the tween will go through the processing flow by calling the Step method.

‍Note: Registration is only allowed if the state of the tween is RaTweenBase.State.None, else it will ignore it.

Type Constraints

TweenT

:

RaTweenBase

Reset()

void RaTweening.Core.RaTweeningProcessor.Reset

(

bool

resumeAfterReset = false

)

Resets all tweens within the processor.

‍Note: See RaTweenBase.Reset(bool)

Parameters

resumeAfterReset

When True, this will unpause the tween immediately after Reset

Rewind()

void RaTweening.Core.RaTweeningProcessor.Rewind

(

bool

inclDelay = true

)

Rewinds all tweens within the processor.

‍Note: See RaTweenBase.Rewind(bool)

Parameters

inclDelay

Also rewinds the Delay, else it only rewinds the evaluation time

Step()

void RaTweening.Core.RaTweeningProcessor.Step	(	float	deltaTime,
		bool	cleanEndedTweens = true
	)

This method progresses the tweens registered through their various states. Handling their delays, lifetime, evaluations and all other state related aspects.

Parameters

deltaTime	Time to progres the registered tweens with
cleanEndedTweens	on True, calls CleanEndedTweens at end of step

Stop()

void RaTweening.Core.RaTweeningProcessor.Stop

(

bool

cleanEndedTweens = true

)

Ends all tweens within the processor

‍Note: See RaTweenBase.Stop()

Parameters

cleanEndedTweens

UnregisterTween< TweenT >()

TweenT RaTweening.Core.RaTweeningProcessor.UnregisterTween< TweenT >

(

TweenT

tween

)

This method attempts to unregister the given tween from the system. After Unregistration, the tween will no longer go through the processing flow by calling the Step method.

‍Note: Unregistration is only allowed if the state of the tween is NOT RaTweenBase.State.None, else it will ignore it.

Type Constraints

TweenT

:

RaTweenBase