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

A RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Rect of a Camera

‍Note: You can have it target the Pixel Rect by calling RaTweenRect.SetPixelRect(bool)
Note: RaTweenUtilExtensions for all extension methods

More...

Inheritance diagram for RaTweening.RaCamera.RaTweenRect:
RaTweening.RaTweenDynamic< Camera, Rect >

Public Member Functions

 RaTweenRect (Camera target, Rect startRect, Rect endRect, float duration)
 
 RaTweenRect (Camera target, Rect endRect, float duration)
 
RaTweenRect SetPixelRect (bool enabled=true)
 When true, the Camera.pixelRect will be affected instead of the Camera.rect

‍Note: The values will represent pixels instead of Units

More...
 
RaTweenRect SetExcludeValues (RectValue excludeValues)
 Makes it so the given Rect Values are excluded from the tween. So they remain the value they have at the moments of evaluation More...
 
RaTweenRect OnlyIncludeRectValues (RectValue inclValues)
 Makes it so the given Rect Values 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.RaTweenDynamic< Camera, Rect >
 RaTweenDynamic (TargetT target, ValueT start, ValueT end, float duration)
 
 RaTweenDynamic (TargetT target, ValueT end, float duration)
 
RaTweenDynamic< TargetT, ValueT > From ()
 Makes it so the End value set within the tween becomes the start value And the start value becomes the value currently set within the target

‍Note: This method Disables SetStartDynamic(bool)

More...
 
RaTweenDynamic< TargetT, ValueT > SetStartValue (ValueT start)
 This API call Sets the start value of the tween.

‍Note: This makes it so the SetStartRef(TargetT) is cleared.
Note: This makes it so the SetStartDynamic(bool) is set to false

More...
 
RaTweenDynamic< TargetT, ValueT > SetStartRef (TargetT start)
 This API call Sets the start reference of the tween. The tween will copy the value from the reference to determine its start value at runtime. SetDynamicSetupStep(RaTweenDynamicSetupStep) to see when this value is calculated

‍Note: this makes it so the SetStartValue(ValueT) is cleared.
Note: This makes it so the SetStartDynamic(bool) is set to false

More...
 
RaTweenDynamic< TargetT, ValueT > SetEndValue (ValueT end)
 This API call Sets the end value of the tween.

‍Note: this makes it so the SetEndRef(TargetT) is cleared.

More...
 
RaTweenDynamic< TargetT, ValueT > SetEndRef (TargetT end)
 This API call Sets the end reference of the tween. The tween will copy the value from the reference to determine its end value at runtime. SetDynamicSetupStep(RaTweenDynamicSetupStep) to see when this value is calculated

‍Note: this makes it so the SetEndValue(ValueT) is cleared.

More...
 
RaTweenDynamic< TargetT, ValueT > SetTarget (TargetT target)
 This API call Sets target on which to apply the tween This target will be tweening from the start value to the end value More...
 
RaTweenDynamic< TargetT, 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...
 
RaTweenDynamic< TargetT, 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...
 
RaTweenDynamic< TargetT, 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 void SetDefaultValues ()
 
override void DynamicEvaluation (float normalizedValue, Camera target, Rect start, Rect end)
 
override RaTweenDynamic< Camera, Rect > DynamicClone ()
 
override Rect ReadValue (Camera reference)
 
override Rect GetEndByDelta (Rect start, Rect delta)
 
- Protected Member Functions inherited from RaTweening.RaTweenDynamic< Camera, Rect >
abstract RaTweenDynamic< TargetT, ValueT > DynamicClone ()
 
abstract ValueT GetEndByDelta (ValueT start, ValueT delta)
 
abstract ValueT ReadValue (TargetT reference)
 
override void SetDefaultValues ()
 
override void ApplyRewind (bool resumeAfterRewind)
 
override RaTween RaTweenClone ()
 
override void OnSetup ()
 
override void OnStart ()
 
override void Evaluate (float normalizedValue)
 
override void Dispose ()
 
abstract void DynamicEvaluation (float normalizedValue, TargetT target, ValueT start, ValueT end)
 

Additional Inherited Members

- Properties inherited from RaTweening.RaTweenDynamic< Camera, Rect >
TargetT Target [get]
 The Target to apply the value evaluation on
 
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)
 
override bool IsValid [get]
 

Detailed Description

A RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Rect of a Camera

‍Note: You can have it target the Pixel Rect by calling RaTweenRect.SetPixelRect(bool)
Note: RaTweenUtilExtensions for all extension methods

Member Function Documentation

◆ DynamicClone()

override RaTweenDynamic< Camera, Rect > RaTweening.RaCamera.RaTweenRect.DynamicClone ( )
protectedvirtual

◆ OnlyIncludeRectValues()

RaTweenRect RaTweening.RaCamera.RaTweenRect.OnlyIncludeRectValues ( RectValue  inclValues)

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

Parameters
inclValuesThe Rect Values to include. This is a flagged value

◆ SetExcludeValues()

RaTweenRect RaTweening.RaCamera.RaTweenRect.SetExcludeValues ( RectValue  excludeValues)

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

Parameters
excludeValuesThe Rect Values to exclude. This is a flagged value

◆ SetPixelRect()

RaTweenRect RaTweening.RaCamera.RaTweenRect.SetPixelRect ( bool  enabled = true)

When true, the Camera.pixelRect will be affected instead of the Camera.rect

‍Note: The values will represent pixels instead of Units

Parameters
enabled
Returns