RaTweening 1.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
RaTweening.Lambda.RaTweenLambdaColor Class Reference

A RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Color

‍Note: RaTweenLambda for all methods

More...

Inheritance diagram for RaTweening.Lambda.RaTweenLambdaColor:
RaTweening.Lambda.RaTweenLambdaBase< Color >

Public Member Functions

 RaTweenLambdaColor (Color start, Color end, float duration, SetterHandler setter, IsValidHandler isValidHandler=null)
 
RaTweenLambdaColor SetExcludeChannels (Channel excludeChannels)
 Makes it so the given color channels are excluded from the tween. So they remain the value they have at the moments of evaluation More...
 
RaTweenLambdaColor OnlyIncludeChannels (Channel inclChannels)
 Makes it so the given color channels which are not specified by the input are excluded. So they remain the value they have at the moments of evaluation More...
 
- Public Member Functions inherited from RaTweening.Lambda.RaTweenLambdaBase< Color >
delegate void SetterHandler (ValueT value, float normalizedValue)
 The Delegate which passes a value and normalized value to determine the setter logics

‍Note: normalizedValue is a value where 0 == Start and 1 == End. This is passed for extra info.

More...
 
delegate bool IsValidHandler ()
 The Delegate which returns true if the tween is valid, and false if the tween should be terminated (Think of null reference prevention)
 
 RaTweenLambdaBase (ValueT start, ValueT end, float duration, SetterHandler setter, IsValidHandler isValidHandler=null)
 
RaTweenLambdaBase< ValueT > SetStartValue (ValueT start)
 This API call Sets the start value of the tween. More...
 
RaTweenLambdaBase< ValueT > SetEndValue (ValueT end)
 This API call Sets the end value of the tween. More...
 
RaTweenLambdaBase< ValueT > SetEndIsDelta (bool enabled=true)
 Makes it so the value set within the end value or reference is calculated as delta at runtime So an end value of 5 while the target is at value 20 would result in a final end value of 25. SetDynamicSetupStep(RaTweenDynamicSetupStep) to see when this value is calculated More...
 
RaTweenLambdaBase< ValueT > SetStartDynamic (bool enabled=true)
 Makes it so the value set within the start value or reference is ignored and rather the value at which the object is at calculation time has is used as start value. SetDynamicSetupStep(RaTweenDynamicSetupStep) to see when this value is calculated More...
 
RaTweenLambdaBase< ValueT > SetDynamicSetupStep (RaTweenDynamicSetupStep step)
 Determines when the SetStartDynamic(bool) and the SetEndIsDelta(bool) are calculated Read RaTweenDynamicSetupStep for the details on the calculation steps

‍Note: When set to RaTweenDynamicSetupStep.Start, it recalculates the values on each loop

More...
 

Protected Member Functions

override RaTweenLambdaBase< Color > CloneLambdaTween ()
 
override void LambdaEvaluation (float normalizedValue, Color start, Color end)
 
override Color GetEndByDelta (Color start, Color delta)
 
- Protected Member Functions inherited from RaTweening.Lambda.RaTweenLambdaBase< Color >
override void OnSetup ()
 
override void OnStart ()
 
override void SetDefaultValues ()
 
override void ApplyRewind (bool resumeAfterRewind)
 
override void Evaluate (float normalizedValue)
 
override RaTween RaTweenClone ()
 
override void Dispose ()
 
void WriteValue (ValueT value, float normalizedValue)
 
abstract RaTweenLambdaBase< ValueT > CloneLambdaTween ()
 
abstract ValueT GetEndByDelta (ValueT start, ValueT delta)
 
abstract void LambdaEvaluation (float normalizedValue, ValueT start, ValueT end)
 

Additional Inherited Members

- Properties inherited from RaTweening.Lambda.RaTweenLambdaBase< Color >
ValueT Start [get]
 The Value to start the Tween at (in which state it will begin)
 
ValueT End [get]
 The value to end the Tween to (in which state it will result)
 
ValueT Value [get]
 The value which is recorded by the evaluation of the tween (The current value of the imaginary target)
 
override bool IsValid [get]
 

Detailed Description

A RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Color

‍Note: RaTweenLambda for all methods

Member Function Documentation

◆ CloneLambdaTween()

override RaTweenLambdaBase< Color > RaTweening.Lambda.RaTweenLambdaColor.CloneLambdaTween ( )
protectedvirtual

◆ OnlyIncludeChannels()

RaTweenLambdaColor RaTweening.Lambda.RaTweenLambdaColor.OnlyIncludeChannels ( Channel  inclChannels)

Makes it so the given color channels which are not specified by the input are excluded. So they remain the value they have at the moments of evaluation

Parameters
inclChannelsThe color channels to include. This is a flagged value

◆ SetExcludeChannels()

RaTweenLambdaColor RaTweening.Lambda.RaTweenLambdaColor.SetExcludeChannels ( Channel  excludeChannels)

Makes it so the given color channels are excluded from the tween. So they remain the value they have at the moments of evaluation

Parameters
excludeChannelsThe channels to exclude. This is a flagged value