UxrCanvasAlphaTween Class
Tweening component to animate the alpha of a CanvasGroup component programatically or using the inspector.
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
Namespace: UltimateXR.Animation.UI
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
[RequireComponent(typeof(CanvasGroup))]
public class UxrCanvasAlphaTween : UxrTween
The UxrCanvasAlphaTween type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | UxrCanvasAlphaTween |
Properties
| Name | Description | |
|---|---|---|
 | EndAlpha | Animation end alpha |
| StartAlpha | Animation start alpha |
 | TargetBehaviour | Gets the Behaviour the tween animates. (Overrides UxrTween.TargetBehaviour.) |
| TargetCanvasGroup |
Methods
| Name | Description | |
|---|---|---|
 | Animate | Creates and starts a tweening animation for the alpha value of a CanvasGroup component. |
| AnimateAsync | Same as Animate(CanvasGroup, Single, Single, UxrInterpolationSettings, Action(UxrTween)) but for use with async/await. |
| FadeIn | Creates and starts a fade-in tweening animation for the alpha value of a CanvasGroup component. The alpha value will go from 0.0 to 1.0. |
| FadeInAsync | Same as FadeIn(CanvasGroup, Single, Single, Action(UxrTween)) but for use with async/await. |
| FadeOut | Creates and starts a fade-out tweening animation for the alpha value of a CanvasGroup component. The alpha value will go from 1.0 to 0.0. |
| FadeOutAsync | Same as FadeOut(CanvasGroup, Single, Single, Action(UxrTween)) but for use with async/await. |
 | Interpolate | Interpolates and assigns the value corresponding to the given LERP value. (Overrides UxrTween.Interpolate(Single).) |
| RestoreOriginalValue | Restores the animated component to the state before the animation started. (Overrides UxrTween.RestoreOriginalValue().) |
| StoreOriginalValue | Stores the original value before the animation, in order to be able to restore it later using RestoreOriginalValue(). (Overrides UxrTween.StoreOriginalValue().) |
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.) |