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

NameDescription
Public methodUxrCanvasAlphaTween

Properties

NameDescription
Public propertyEndAlpha Animation end alpha
Public propertyStartAlpha Animation start alpha
Protected propertyTargetBehaviour Gets the Behaviour the tween animates. (Overrides UxrTween.TargetBehaviour.)
Public propertyTargetCanvasGroup

Methods

NameDescription
Public methodStatic memberAnimate Creates and starts a tweening animation for the alpha value of a CanvasGroup component.
Public methodStatic memberAnimateAsync Same as Animate(CanvasGroup, Single, Single, UxrInterpolationSettings, Action(UxrTween)) but for use with async/await.
Public methodStatic memberFadeIn 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.
Public methodStatic memberFadeInAsync Same as FadeIn(CanvasGroup, Single, Single, Action(UxrTween)) but for use with async/await.
Public methodStatic memberFadeOut 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.
Public methodStatic memberFadeOutAsync Same as FadeOut(CanvasGroup, Single, Single, Action(UxrTween)) but for use with async/await.
Protected methodInterpolate Interpolates and assigns the value corresponding to the given LERP value. (Overrides UxrTween.Interpolate(Single).)
Protected methodRestoreOriginalValue Restores the animated component to the state before the animation started. (Overrides UxrTween.RestoreOriginalValue().)
Protected methodStoreOriginalValue Stores the original value before the animation, in order to be able to restore it later using RestoreOriginalValue(). (Overrides UxrTween.StoreOriginalValue().)

Extension Methods

NameDescription
Public Extension MethodCheckSetEnabled Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
Public Extension MethodGetOrAddComponent<T> Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
Public Extension MethodGetPathUnderScene Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
Public Extension MethodGetSceneUid Gets an unique identifier string for the given component. (Defined by ComponentExt.)
Public Extension MethodGetUniqueScenePath 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.)
Public Extension MethodLoopCoroutine Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
Public Extension MethodSafeGetComponentInParent<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.)
Public Extension MethodShowInInspector(Boolean)Overloaded.
Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
Public Extension MethodShowInInspector(Boolean, Boolean)Overloaded.
Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Animation.UI Namespace