UxrTween Class
Base abstract class to create tweening components to animate Unity UI elements.
Tweens are UxrComponent components to allow access to the global list of tweens or filter by type.
They are also UxrComponent<TP, TC> to allow access to the global list of tweens in a given parent canvas.
Inheritance Hierarchy
System.Object
Object
Component
Behaviour
MonoBehaviour
UltimateXR.Core.Components.UxrComponent
UltimateXR.Core.Components.UxrComponent(UxrTween)
UltimateXR.Core.Components.UxrComponent(Canvas, UxrTween)
UltimateXR.Animation.UI.UxrTween
UltimateXR.Animation.UI.UxrCanvasAlphaTween
UltimateXR.Animation.UI.UxrGraphicTween
UltimateXR.Animation.UI.UxrTextContentTween
Namespace: UltimateXR.Animation.UI
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
public abstract class UxrTween : UxrComponent<Canvas, UxrTween>
The UxrTween type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | UxrTween |
Properties
| Name | Description | |
|---|---|---|
 | AnimationTime | Gets the current animation time in seconds. The animation time is the scaled or unscaled time relative to the time the component was enabled. |
 | FinishedCallback | Optional finished callback assigned by child classes. |
| HasFinished | Gets whether the animation finished. |
| HasOriginalValueStored | Gets if the tween has gathered the original animated parameter value. |
| InterpolationSettings | Gets or sets the interpolation settings. |
| TargetBehaviour | Gets the Behaviour the tween animates. |
Methods
| Name | Description | |
|---|---|---|
  | HasActiveTween<T> | Checks if the given behaviour has a running tween of a specific type. |
| Interpolate | Interpolates and assigns the value corresponding to the given LERP value. |
| OnEnable | Stores the start time each time the component is enabled. (Overrides UxrComponent<T>.OnEnable().) |
| OnFinished | Event trigger for the Finished event. |
| Restart | Restarts the animation with the current parameters. |
| RestoreOriginalValue | Restores the animated component to the state before the animation started. |
| SetFinishedActions | Sets the actions to perform when the animation finished. |
| Stop(Boolean) | Stops the tweening animation. |
| Stop<T>(Behaviour, Boolean) | Stops the tweening animation on an object if it has a T component currently added. |
| StopAll(Boolean) | Stops all enabled tweens. |
| StopAll(Behaviour, Boolean) | Stops all the tweening components of a Behaviour. |
| StopAll<T>(Boolean) | Stops all enabled tweens of a given type. |
| StopAllInParentCanvas(Canvas, Boolean) | Stops all enabled tweens that are in a given canvas. |
| StopAllInParentCanvas<T>(Canvas, Boolean) | Stops all enabled tweens of a given type that are in a given canvas. |
| StoreOriginalValue | Stores the original value before the animation, in order to be able to restore it later using RestoreOriginalValue(). |
Events
| Name | Description | |
|---|---|---|
 | Finished | Called when the animation finished. |
Extension Methods
| Name | Description | |
|---|---|---|
 | CheckSetEnabled | Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.) |
| GetOrAddComponent<T> | Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.) |
| GetPathUnderScene | Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.) |
| GetSceneUid | Gets an unique identifier string for the given component. (Defined by ComponentExt.) |
| GetUniqueScenePath | Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.) |
| LoopCoroutine | Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.) |
| SafeGetComponentInParent<T> | Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.) |
| ShowInInspector(Boolean) | Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.) |
| ShowInInspector(Boolean, Boolean) | Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.) |
| ThrowIfNull | Throws an exception if the object is null. (Defined by ObjectExt.) |